home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1997 September / Macworld (1997-09).dmg / Shareware World / Comms & Internet / SB114 / Plugin Docs / Script Configuration < prev    next >
Text File  |  1997-05-27  |  2KB  |  36 lines
  1. ShadowBotScripting Language, Version 1.1.2
  2. © John Bafford, 1996-1997
  3.  
  4. Script Configuration
  5.  
  6. These commands are used to configure plugins. They should appear, one per line, at the top of files to be used as plugins.
  7.  
  8. *COMMAND commandName minAccess
  9.     Makes a new command responding to commandName. For this command to execute, the person executing it must have access of at least minAccess.
  10.     The entry point for this type of plugin is the first command of the script, or at the line after an @ENTRY commandName, if one is found. Command names are limited to 30 characters.
  11.  
  12. *ALIAS command mappedTo
  13.     Aliases a command to another. For example, "*ALIAS Q DIE" would map !Q to !DIE.
  14.  
  15. *LIST command minaccess
  16.     The file is treated as a list. The URL plugin is a good example. See the Lists file for more information.
  17.  
  18. *ONTEXT "textMask" minAccess maxAccess
  19.     This can be used to make the bot respond to text typed in the channel. If the user's access level falls between minAccess and maxAccess, or is greater than minAccess if maxAccess = 0, and the text matches the textMask, the script is executed.
  20.     Example: *ONTEXT "*zzz*" -1 900
  21.                                 if someone types 'zzz' anywhere in a string, and their access is under 901, the script is executed.
  22.     If you are mixing ONTEXT and COMMAND entries in a single file, the entry point for an ONTEXT is either the top of the script, or an @ENTRY of the textMask (sans quotes), for example, @ENTRY *zzz*
  23.  
  24. *WRITELN theText
  25.     Outputs theText to the console when the script is loaded at program launch.
  26.  
  27. *GLOBAL type name [initial value]
  28.     Creates a variable for the last defined plugin. Valid types are 'str' (string), 'int' (integer), and 'bool' (boolean) (no quotes). If the initial value is set, the variable is set to that value. For booleans, "TRUE" (no quotes) sets it to true; all other values set it to false.
  29.  
  30. *MAXRUNNING <number>
  31.     If this configuration command is found, and number > 0, the last *COMMAND or *ONTEXT is limited to number simultaneous executions.
  32.  
  33. *ENDCONF
  34.     Anything after this is not processed. It's a very good idea to put *ENDCONF in, especially if your plugin is long, because it speeds up launch time.
  35.  
  36. Configuration commands should be located at the top of your plugin file, or in a file with the same name as the plugin with a '.h' after it.